From: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
Date: Mon, 28 Jan 2013 18:02:04 +0000 (-0500)
Subject: docs: Document the dom0_vga_console_info structure.
X-Git-Tag: archive/raspbian/4.8.0-1+rpi1~1^2~7071^2~2
X-Git-Url: https://dgit.raspbian.org/%22http:/www.example.com/cgi/%22https:/%22bookmarks://%22Dat/%22http:/www.example.com/cgi/%22https:/%22bookmarks:/%22Dat?a=commitdiff_plain;h=32c32508c8e8d24da67eb8cdc6a1c2972385f255;p=xen.git

docs: Document the dom0_vga_console_info structure.

Mark-up for inclusion of generated docs.

Acked-by: Ian Campbell <ian.campbel@citrix.com>
[v2: s/dom9/dom0/]
Signed-off-by: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
---

diff --git a/xen/include/public/xen.h b/xen/include/public/xen.h
index 10912290cb..73fd7e779f 100644
--- a/xen/include/public/xen.h
+++ b/xen/include/public/xen.h
@@ -779,7 +779,14 @@ struct xen_multiboot_mod_list
     /* Unused, must be zero */
     uint32_t pad;
 };
-
+/*
+ * `incontents 200 startofday_dom0_console Dom0_console
+ *
+ * The console structure in start_info.console.dom0
+ *
+ * This structure includes a variety of information required to
+ * have a working VGA/VESA console.
+ */
 typedef struct dom0_vga_console_info {
     uint8_t video_type; /* DOM0_VGA_CONSOLE_??? */
 #define XEN_VGATYPE_TEXT_MODE_3 0x03